Edit a region

This request edits an existing ride region for a client.

Request syntax

POST  https://b2b-api.go.yandex.ru/integration/2.0/geo_restrictions/update?id={region ID}

Request headers

  • Authorization: Bearer <OAuth-token>
    OAuth access token. The steps to get a token are described in Getting started.
  • X-YaTaxi-Selected-Corp-Client-Id — client ID from the account. Required if multiple clients are available using the token.

Request body

New data for the ride region is passed in the request body in JSON format:

Field

Description

Format

Required

name

Name.

String

Yes

geo_type

Geo restriction type. Currently only circle is supported.

String

Yes

geo

Geo restriction description. Contains the following fields:

  • center: The coordinates of the center point.
  • radius: The distance from the center (in meters).

Object

Yes

Response field description

Responses may contain the following fields:

Field Description Format
id Ride region ID. String

Request example

POST https://b2b-api.go.yandex.ru/integration/2.0/geo_restrictions/update?id=b45e...f0de
  {
    "geo": {
      "center": [
        37.642639,
        55.734894
      ],
      "radius": 200
    },
    "geo_type": "circle",
    "name": "Office 2"
  }

Response example

An example response to this request looks like this:

  {
      "id": "b45e...f0de"
  }

Response codes

The response to this request may contain the following standard HTTP codes:

  • 200: Request completed successfully.
  • 400: An unknown parameter or a parameter with an invalid value was passed in the request.
  • 401: The OAuth token is incorrect.
  • 403: The client doesn't have sufficient rights to run this request.
    • SELECT_CLIENT_HEADER_REQUIRED: the request did not pass the header X-YaTaxi-Selected-Corp-Client-Id (returned if more than one client is available for the token).
    • SELECTED_CLIENT_ACCESS_DENIED: the header X-YaTaxi-Selected-Corp-Client-Id contains the client's ID, which this login does not have access to.
  • 404: The specified record wasn't found.
Previous
Create a new region
Next
Remove region